If Allow All Values is selected, the All option appears for the level and all attribute values available in the child level are displayed. Otherwise, only attribute values filtered by a parent level are displayed.

Use (1 - Yes) to enable.

If Allow Blank Values is selected, the Not Specified option appears for the level and facilities can be displayed if no attribute value is specified.

Use (1 - Yes) to enable.

[AutoRestart] specifies whether TheView automatically restarts when a user changes a Facility Navigation Bar object, a Group Grid object, or a Group Navigation Bar object.

[AutoRestart] is typically used to reset the Facility ID of TheView for templated objects. It is not required to reset the contents in a Group Grid object.

When used with a Facility Navigation Bar or a Group Navigation Bar, the [Facility] property of TheView is set to match the facility selected in the drop-down menu.

When used with a Group Grid object, the [Facility] property of TheView changes to match the Group Grid row when the row is clicked.

Use (1 - Yes) to enable. The default is 0 - No.

AutoSizeFont specifies whether the object’s font is automatically resized:

Shrink to Fit and Expand to Fit resize the font in Edit mode so that the text fits the boundary of the object. You can use these options to resize the font without using the object’s Font property to explicitly set the font size. In Run mode, the font is dynamically resized in Run mode to accommodate the [DisplayItem] or the tokens specified by the Text property.

• Shrink to Fit - reduces the font size so the text fits in the object boundary. If the object is resized in Run mode, the font size can never exceed the size specified by the object’s Font property.
• Expand to Fit - increases the font size so the text fills the object boundary. If the object is resized in Run mode, the font size can never be less than the size specified by the object’s Font property.
• Best Fit - resizes the font to best fit the text inside the object boundary. If the object is resized in Run mode, the font is also resized. This setting is a combination of Shrink to Fit and Expand to Fit.

Proportional and Proportional Fit resize the font in Run mode based on resizing of TheView.

• Proportional - resizes the font proportionally to TheView as TheView is resized.
• Proportional Fit - resizes the font proportionally to the object as the object is resized. This option reduces the font size only when necessary to view all of the text. This is the recommended option when font resizing is required.

Available AutoSizeFont options are 1 - Shrink to Fit, 2 - Expand to Fit, 3 - Best Fit, 4 - Proportional, and 5 - Proportional Fit. The default is 0 - No (no font resizing).

BackColor selects a background color for the Facility Navigation BarTool.

BorderStyle specifies the border style of the Facility Navigation Bar windows. Available values are:

• 1 - None
• 2 - Fixed single

Bottom specifies the distance in pixels from the top of the object to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object.

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 - Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 - Arrow
• 2 - IBeam
• 3 - Cross
• 4 - UpArrow
• 5 - NoDrop
• 6 - Help
• 99 - HotSpot
• 100 - Timer

Script subtype is long.

DisplayFont returns the current, resized font values for the object. The correct font size is returned only if AutoSizeFont is enabled. For tools other than Text Tool, DDS Editor Button, SetPoint Button, and UIS Command Button DisplayFont is identical to the Font property, except that this is a font interface object instead of a string.

This property is read only.

Enable specifies whether the user is able to interact with the object. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If set to 0 - No, the object is still visible but its context menu is disabled.

Other options:

• Completely hide the object in run mode using the Visible property.
• Display the object but hide its [DisplayItem] using the [DisplayElement] property.

Specifies the user descriptions of Facility Navigation Bar attributes.

Specifies the values of Facility Navigation Bar attributes.

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 - None (no resizing occurs)
• 1 - Shift (the object is shifted)
• 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 - None (no resizing occurs)
• 1 - Shift (the object is shifted)
• 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status.

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 - No and 1 - Yes. The default is 0 - No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 - Yes for the first object in the group.

5. Set Group set to 0 - No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 - Yes and 2) that use a Group property set to 0 - No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

Specifies the GroupID of the object group.

Returns a Boolean value to confirm that a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Initial Filter defines a subset of facilities. If you are defining multiple levels, the Initial Filter is level 0, the leftmost drop-down level in the Facility Navigation Bar Tool. Additional filtering will begin with the level 0 filter.

Specifies the facility Initial Rule filter.

Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.

Specifies the label attribute for a specified level as an integer.

• When this property is set, two parameters are required: an integer that specifies the level for the label attribute and a second integer that identifies the label attribute (for example, FacNavBar.X.LabelAttribute 0, 30).
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttribute(0)).

Specifies the label attribute of a specified level as a string.

• When this property is set, two parameters are required: an integer that specifies the level for the label attribute, and a string that identifies the label attribute (for example, FacNavBar.X.LabelAttributeString 0, "facility_category").
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label attribute being retrieved (for example, MsgBox FacNavBar.X.LabelAttributeString(0)).

Specifies the label text for a specified level.

• When this property is set, two parameters are required: an integer that specifies the level for the label text and a string that is the label text (for example, FacNavBar.X.LabelText 0, "Facility Category").
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label text being retrieved (for example, MsgBox FacNavBar.X.LabelText(0)).

Specifies the label type for a specified level. The property can be 1 - Attribute or 2 - Text.

• When this property is set, two parameters are required: an integer that specifies the level for the label and an integer that specifies the label type (for example, FacNavBar.X.LabelType 0, 1).
• When this property is retrieved, one parameter is required: an integer that specifies the level for the label type (for example, MsgBox FacNavBar.X.LabelType(0)).

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object.

Specifies the total number of drop-down levels in the tool. The default is 3.

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

Displays the OCXProperty dialog box unique to the object.

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object.

Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object.

Specifies whether run-time settings applied using script automatically persist between Facility Navigation Bar loads. Default is 0 - No.

Specifies the registry key to be used for persisting run-time settings. The default is DefaultRuntimeCfg.

Specifies the registry key to which a run-time selection (target) is written for persistence. The default is DefaultSelections.

Specifies whether descriptions (rather than table entry names) are shown for table-driven facility attributes.

Specifies whether labels appear above the drop-down menus. Default is 1 - Yes.

If Levels is selected, the last drop-down menu in the Facility or Group Navigation Bar contains a list of facilities or leaf nodes based on the last level. Otherwise, the last drop-down shows the last level in the hierarchy.

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

The script subtype is string.

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 - No and 1 - Yes. Default is 1 - Yes.

Script subtype is long.

See also Group and Tab Order.

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Returns the number of the target level of the filter hierarchy.

TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text.

For information about building dynamic text using tokens, see Using Text Tokens.

Script subtype is string.

Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution.

Script subtype is string.

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object.

Visible secifies whether the object is visible in Run mode. Options are 0 - No or 1 - Yes. Default is 1 - Yes.

You can also:

• Display the object but hide its [DisplayItem] using the [DisplayElement] property.
• Show both the object and its [DisplayItem] but disable user interaction using the Enable property.
• Hide the object if the point does not exist using the [UnknownTag].

Specifies the width of the combo box at the specified filter level.

• When this property is set, two parameters are required: an integer that specifies the level for the width setting and an integer that represents the width (for example, FacNavBar.X.Width 0, 100).
• When this property is retrieved, one parameter is required: an integer that identifies the level for the width being retrieved (for example, MsgBox FacNavBar.X.Width(0)).